Summary

Fully Qualified Name:	Laminas\Cache\Pattern\PatternOptions
Extends:	AbstractOptions

Description

Methods

Name	Description	Defined By
__construct()	Constructor	PatternOptions
__get()	Get a configuration property	AbstractOptions
__isset()	Test if a configuration property is null	AbstractOptions
__set()	Set a configuration property	AbstractOptions
__unset()	Set a configuration property to NULL	AbstractOptions
getCacheByDefault()	Do we cache by default?	PatternOptions
getCacheOutput()	Will we cache output?	PatternOptions
getClass()	Get class name	PatternOptions
getClassCacheMethods()	Get list of methods from which to cache return values	PatternOptions
getClassNonCacheMethods()	Get list of methods from which NOT to cache return values	PatternOptions
getDirPermission()	Gets directory permission	PatternOptions
getFileLocking()	Is file locking enabled?	PatternOptions
getFilePermission()	Gets file permission	PatternOptions
getIndexFilename()	Get value for index filename	PatternOptions
getObject()	Get object to cache	PatternOptions
getObjectCacheMagicProperties()	Should we cache magic properties?	PatternOptions
getObjectCacheMethods()	Get list of object methods for which to cache return values	PatternOptions
getObjectKey()	Get object key	PatternOptions
getObjectNonCacheMethods()	Get list of object methods for which NOT to cache return values	PatternOptions
getPublicDir()	Get location of public directory	PatternOptions
getStorage()	Get storage adapter	PatternOptions
getUmask()	Get umask	PatternOptions
setCacheByDefault()	Set flag indicating whether or not to cache by default	PatternOptions
setCacheOutput()	Set whether or not to cache output	PatternOptions
setClass()	Set class name	PatternOptions
setClassCacheMethods()	Set list of method return values to cache	PatternOptions
setClassNonCacheMethods()	Set list of method return values NOT to cache	PatternOptions
setDirPermission()	Set directory permission	PatternOptions
setFileLocking()	Set whether or not file locking should be used	PatternOptions
setFilePermission()	Set file permission	PatternOptions
setFromArray()	Set one or more configuration properties	AbstractOptions
setIndexFilename()	Set value for index filename	PatternOptions
setObject()	Set object to cache	PatternOptions
setObjectCacheMagicProperties()	Set flag indicating whether or not to cache magic properties	PatternOptions
setObjectCacheMethods()	Set list of object methods for which to cache return values	PatternOptions
setObjectKey()	Set the object key part.	PatternOptions
setObjectNonCacheMethods()	Set list of object methods for which NOT to cache return values	PatternOptions
setPublicDir()	Set location of public directory	PatternOptions
setStorage()	Set storage adapter	PatternOptions
setUmask()	Set umask	PatternOptions
toArray()	Cast to array	AbstractOptions

Method Details

__construct()

Constructor

Parameter Name	Type	Description
$options	array|\Traversable|null

Returns: \PatternOptions

__get()

Get a configuration property

Parameter Name	Type	Description
$key	string

Returns: mixed

__isset()

Test if a configuration property is null

Parameter Name	Type	Description
$key	string

Returns: bool

__set()

Set a configuration property

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: void

__unset()

Set a configuration property to NULL

Parameter Name	Type	Description
$key	string

Returns: void

getCacheByDefault()

Do we cache by default?

Used by:

• ClassCache
• ObjectCache

Returns: bool

getCacheOutput()

Will we cache output?

Used by:

• CallbackCache
• ClassCache
• ObjectCache

Returns: bool

getClass()

Get class name

Used by:

• ClassCache

Returns: null|string

getClassCacheMethods()

Get list of methods from which to cache return values

Used by:

• ClassCache

Returns: array

getClassNonCacheMethods()

Get list of methods from which NOT to cache return values

Used by:

• ClassCache

Returns: array

getDirPermission()

Gets directory permission

Returns: bool|int

getFileLocking()

Is file locking enabled?

Used by:

• CaptureCache

Returns: bool

getFilePermission()

Gets file permission

Returns: bool|int

getIndexFilename()

Get value for index filename

Returns: string

getObject()

Get object to cache

Returns: null|object

getObjectCacheMagicProperties()

Should we cache magic properties?

Used by:

• ObjectCache

Returns: bool

getObjectCacheMethods()

Get list of object methods for which to cache return values

Returns: array

getObjectKey()

Get object key

Used by:

• ObjectCache

Returns: string

getObjectNonCacheMethods()

Get list of object methods for which NOT to cache return values

Returns: array

getPublicDir()

Get location of public directory

Used by:

• CaptureCache

Returns: null|string

getStorage()

Get storage adapter

Used by:

• CallbackCache
• ClassCache
• ObjectCache
• OutputCache

Returns: null|\Storage

getUmask()

Get umask

Used by:

• CaptureCache

Returns: bool|int

setCacheByDefault()

Set flag indicating whether or not to cache by default

Used by:

• ClassCache
• ObjectCache

Parameter Name	Type	Description
$cacheByDefault	bool

Returns: \PatternOptions Provides a fluent interface

setCacheOutput()

Set whether or not to cache output

Used by:

• CallbackCache
• ClassCache
• ObjectCache

Parameter Name	Type	Description
$cacheOutput	bool

Returns: \PatternOptions Provides a fluent interface

setClass()

Set class name

Used by:

• ClassCache

Parameter Name	Type	Description
$class	string

Returns: \PatternOptions Provides a fluent interface

setClassCacheMethods()

Set list of method return values to cache

Used by:

• ClassCache

Parameter Name	Type	Description
$classCacheMethods	array

Returns: \PatternOptions Provides a fluent interface

setClassNonCacheMethods()

Set list of method return values NOT to cache

Used by:

• ClassCache

Parameter Name	Type	Description
$classNonCacheMethods	array

Returns: \PatternOptions Provides a fluent interface

setDirPermission()

Set directory permission

Parameter Name	Type	Description
$dirPermission	bool|int

Returns: \PatternOptions Provides a fluent interface

setFileLocking()

Set whether or not file locking should be used

Used by:

• CaptureCache

Parameter Name	Type	Description
$fileLocking	bool

Returns: \PatternOptions Provides a fluent interface

setFilePermission()

Set file permission

Parameter Name	Type	Description
$filePermission	bool|int

Returns: \PatternOptions Provides a fluent interface

setFromArray()

Set one or more configuration properties

Parameter Name	Type	Description
$options	array|\Traversable|\AbstractOptions

Returns: \AbstractOptions Provides fluent interface

setIndexFilename()

Set value for index filename

Parameter Name	Type	Description
$indexFilename	string

Returns: \PatternOptions Provides a fluent interface

setObject()

Set object to cache

Parameter Name	Type	Description
$object	mixed

Returns: \PatternOptions Provides a fluent interface

setObjectCacheMagicProperties()

Set flag indicating whether or not to cache magic properties

Used by:

• ObjectCache

Parameter Name	Type	Description
$objectCacheMagicProperties	bool

Returns: \PatternOptions Provides a fluent interface

setObjectCacheMethods()

Set list of object methods for which to cache return values

Parameter Name	Type	Description
$objectCacheMethods	array

Returns: \PatternOptions Provides a fluent interface

setObjectKey()

Set the object key part.

Used to generate a callback key in order to speed up key generation.

Used by:

• ObjectCache

Parameter Name	Type	Description
$objectKey	null|string	The

Returns: \PatternOptions Provides a fluent interface

setObjectNonCacheMethods()

Set list of object methods for which NOT to cache return values

Parameter Name	Type	Description
$objectNonCacheMethods	array

Returns: \PatternOptions Provides a fluent interface

setPublicDir()

Set location of public directory

Used by:

• CaptureCache

Parameter Name	Type	Description
$publicDir	string

Returns: \PatternOptions Provides a fluent interface

setStorage()

Set storage adapter

Required for the following Pattern classes:

• CallbackCache
• ClassCache
• ObjectCache
• OutputCache

Parameter Name	Type	Description
$storage	string|array|\Storage

Returns: \PatternOptions Provides a fluent interface

setUmask()

Set umask

Used by:

• CaptureCache

Parameter Name	Type	Description
$umask	bool|int

Returns: \PatternOptions Provides a fluent interface

toArray()

Cast to array

Returns: array